Properties

Name Returns Notes Example
documentCatalog PDDocumentCatalog This will get the document CATALOG. This is guaranteed to not return null.
encryption PDEncryption This will get the encryption dictionary for this document. This will still return the parameters if the document was decrypted. As the encryption architecture in PDF documents is plugable this returns an abstract class, but the only supported subclass at this time is a PDStandardEncryption object.
pages PDPageTree Returns the page tree.
numberOfPages int This will return the total page count of the PDF document.
fields List This will return all of the documents root fields. A field might have children that are fields (non-terminal field) or does not have children which are fields (terminal fields). The fields within an AcroForm are organized in a tree structure. The documents root fields might either be terminal fields, non-terminal fields or a mixture of both. Non-terminal fields mark branches which contents can be retrieved using {@link PDNonTerminalField#getChildren()}.
documentInformation PDDocumentInformation This will get the document info dictionary. This is guaranteed to not return null.
pDFRenderer PDFRenderer

Methods

Name Returns Notes Example
getPage ( pageIndex ) PDPage Returns the page at the given index.
setField ( fieldName, value ) void Attempts to set a value of a field
setFields ( params ) void
fieldExists ( fieldName ) boolean Checks if field exists
save ( ) String Save the current PDF document
close ( ) void This will close the underlying PDF Document.

Ask a question, or offer an answer